<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP network interface integration library: EAPOL Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="cypress_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">lwIP network interface integration library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__wifimwcore__eapol__functions.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">EAPOL Functions<div class="ingroups"><a class="el" href="group__group__lwip__network__interface__integration.html">lwip-network-interface-integration</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<ul>
<li>Provides functions that the application or library can use to register and deregister.</li>
<li>These APIs are generally used by the enterprise security library. </li>
</ul>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga5d501ebe6f09b2f93384fc33de1617a0"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wifimwcore__eapol__functions.html#ga5d501ebe6f09b2f93384fc33de1617a0">cy_wifimwcore_eapol_packet_handler_t</a>) (whd_interface_t whd_iface, whd_buffer_t buffer)</td></tr>
<tr class="memdesc:ga5d501ebe6f09b2f93384fc33de1617a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">EAPOL packet handler function pointer type; on receiving the EAPOL data, the WHD will send the data to the Wi-Fi Middleware Core.  <a href="group__group__wifimwcore__eapol__functions.html#ga5d501ebe6f09b2f93384fc33de1617a0">More...</a><br /></td></tr>
<tr class="separator:ga5d501ebe6f09b2f93384fc33de1617a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab3477cb9900a5387811bf337cb7d42b1"><td class="memItemLeft" align="right" valign="top">cy_rslt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__wifimwcore__eapol__functions.html#gab3477cb9900a5387811bf337cb7d42b1">cy_wifimwcore_eapol_register_receive_handler</a> (<a class="el" href="group__group__wifimwcore__eapol__functions.html#ga5d501ebe6f09b2f93384fc33de1617a0">cy_wifimwcore_eapol_packet_handler_t</a> eapol_packet_handler)</td></tr>
<tr class="memdesc:gab3477cb9900a5387811bf337cb7d42b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API allows registering the callback functions to receive EAPOL packets from the WHD.  <a href="group__group__wifimwcore__eapol__functions.html#gab3477cb9900a5387811bf337cb7d42b1">More...</a><br /></td></tr>
<tr class="separator:gab3477cb9900a5387811bf337cb7d42b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga5d501ebe6f09b2f93384fc33de1617a0" name="ga5d501ebe6f09b2f93384fc33de1617a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d501ebe6f09b2f93384fc33de1617a0">&#9670;&nbsp;</a></span>cy_wifimwcore_eapol_packet_handler_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* cy_wifimwcore_eapol_packet_handler_t) (whd_interface_t whd_iface, whd_buffer_t buffer)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EAPOL packet handler function pointer type; on receiving the EAPOL data, the WHD will send the data to the Wi-Fi Middleware Core. </p>
<p >The buffer should be freed by the EAPOL handler.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">whd_iface</td><td>WHD interface. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Buffer received from the WHD. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab3477cb9900a5387811bf337cb7d42b1" name="gab3477cb9900a5387811bf337cb7d42b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab3477cb9900a5387811bf337cb7d42b1">&#9670;&nbsp;</a></span>cy_wifimwcore_eapol_register_receive_handler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cy_rslt_t cy_wifimwcore_eapol_register_receive_handler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__wifimwcore__eapol__functions.html#ga5d501ebe6f09b2f93384fc33de1617a0">cy_wifimwcore_eapol_packet_handler_t</a>&#160;</td>
          <td class="paramname"><em>eapol_packet_handler</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API allows registering the callback functions to receive EAPOL packets from the WHD. </p>
<p >If the callback is registered, and the received packet is an EAPOL packet, it will be redirected to the registered callback. Passing "NULL" as the handler will deregister the previously registered callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">eapol_packet_handler</td><td>: Callback function to be invoked when EAPOL packets are received from the WHD.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CY_RSLT_SUCCESS if the registration was successful; returns <a class="el" href="group__generic__lwip__whd__port__defines.html">WiFi middleware specific error codes</a> otherwise. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>lwIP network interface integration library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
